/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.document;

import kameleon.exception.KameleonException;

/**
 * Represents an image.
 * 
 * <p>The content of the image can have two forms:
 * <ul>
 * <li>url: path of the actual image file
 * <li>data: raw bytes of the image
 * </ul>
 * 
 * <p>Standard properties include : caption, location and image data.
 * 
 * @author		Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * @version		1.0
 */
public class Image extends TextParagraphElement {

    /**
     * Needed to serialize this class.
     * 
     * @see		java.io.Serializable
     */
	private static final long serialVersionUID = -3577704579586483189L ;

	/**
     * Default legend used when creating an instance of {@code Images}.
     */
    public static final String DEFAULT_IMAGE_CAPTION = "" ;//$NON-NLS-1$
	
    /**
     * Builds an instance with default properties.
     * 
     * <p>The default properties are the following :
     * <ul>
     * <li>caption: {@code ""}
     * </ul>
     */
    public Image() {
    	super();
    	// Setting the default properties
    	try {
    		this.setProperty(CAPTION, DEFAULT_IMAGE_CAPTION) ;
    	} catch (KameleonException e) {/* This should not happen. */}
    }// Image()
    
}// class Image